Initial refactor of OP Mainnet -> OP Stack #1243
Conversation
Still needs various nav fixes an a second eye on necessary changes
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -11,7 +11,7 @@ import { SuperchainContractTable } from '@/components/SuperchainContractTable' | |||
|
|
|||
| # Contract Addresses | |||
|
|
|||
| This reference guide lists all the contract addresses for Mainnet and Testnet, as found on the [superchain-registry](https://github.com/ethereum-optimism/superchain-registry/tree/main). | |||
| This reference guide lists all the contract addresses for OP Stack chains, as found on the [superchain-registry](https://github.com/ethereum-optimism/superchain-registry/tree/main). | |||
There was a problem hiding this comment.
What do we do with this file? Is there a way to expand it to include all contract addresses across the Superchain?
📝 WalkthroughWalkthroughThis pull request involves a comprehensive terminology update across multiple documentation pages, shifting the focus from "OP Mainnet" to "OP Stack chains". The changes are primarily semantic, updating titles, descriptions, and references to reflect a broader perspective on the Optimism ecosystem. The modifications span several documentation files including addresses, getting started, networks, security FAQ, privileged roles, security policy, testing, and token list pages. The updates aim to emphasize the scalable and flexible nature of the OP Stack, presenting it as a framework for multiple blockchain implementations rather than a single mainnet. Sequence DiagramsequenceDiagram
participant Docs as Documentation
participant OPStack as OP Stack Chains
participant Ethereum as Ethereum L1
Docs->>OPStack: Update terminology
Docs->>OPStack: Broaden scope from Mainnet
Docs->>Ethereum: Maintain contextual references
OPStack-->>Docs: Reflect comprehensive framework
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (10)
pages/chain/addresses.mdx (1)
14-14: Consider rephrasing for clarity and conciseness.The sentence repeats information about the superchain-registry that's already mentioned in the following callout. Consider:
-This reference guide lists all the contract addresses for OP Stack chains, as found on the [superchain-registry](https://github.com/ethereum-optimism/superchain-registry/tree/main). +This reference guide lists all the contract addresses for OP Stack chains.pages/chain/testing/testing-apps.mdx (2)
15-15: Improve text formatting and clarity.The italicized word placement within "could" makes the sentence awkward. Consider:
-In those cases, while you *could* test everything on an OP Stack chain or a test network, that would normally be inefficient. +In those cases, while you could test everything on an OP Stack chain or a test network, this would normally be inefficient.
21-21: Break down the complex sentence for better readability.The sentence is too long and could be split for clarity:
-Running proper testing is key to identifying fringe cases where the equivalence between OP Stack chains and Ethereum breaks down (or where Ethereum mainnet itself and the development stack may be non-equivalent in a production environment). +Running proper testing is key to identifying fringe cases where the equivalence between OP Stack chains and Ethereum breaks down. This testing can also reveal cases where Ethereum mainnet itself and the development stack may be non-equivalent in a production environment.pages/chain/security/security-policy.mdx (1)
31-31: Improve sentence structure and conciseness.The sentence contains redundant phrasing and missing punctuation:
-If you think you have found a significant bug or vulnerabilities in OP Stack smart contracts, infrastructure, etc., even if that component is not covered by an existing bug bounty, please report it via the [Immunefi program](https://immunefi.com/bounty/optimism/). The impact of any and all reported issues will be considered and the program has previously rewarded security researchers for bugs not within its stated scope. +If you think you have found a significant bug or vulnerabilities in OP Stack smart contracts, infrastructure, etc., even if that component is not covered by an existing bug bounty, please report it via the [Immunefi program](https://immunefi.com/bounty/optimism/). The impact of all reported issues will be considered, and the program has previously rewarded security researchers for bugs not within its stated scope.🧰 Tools
🪛 LanguageTool
[style] ~31-~31: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...fi.com/bounty/optimism/). The impact of any and all reported issues will be considered and ...(EN_WORDINESS_PREMIUM_ANY_AND_ALL)
[uncategorized] ~31-~31: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...d all reported issues will be considered and the program has previously rewarded sec...(COMMA_COMPOUND_SENTENCE_2)
pages/chain/getting-started.mdx (1)
55-55: Add missing comma before "such as".-This lets you debug parts that are OP Stack chains specific such as calls to bridges to transfer ETH or tokens between layers. +This lets you debug parts that are OP Stack chains specific, such as calls to bridges to transfer ETH or tokens between layers.🧰 Tools
🪛 LanguageTool
[uncategorized] ~55-~55: A comma might be missing here.
Context: ...ou debug parts that are OP Stack chains specific such as calls to bridges to transfer ET...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
pages/chain/security/faq.mdx (2)
18-19: Consider using a callout for critical security information.This critical security information about the multisig dependency and potential risks should be more prominent. Consider using the
Calloutcomponent:-At the moment, **it's important to understand that the security of OP Stack chains is dependent on a [multisig](https://etherscan.io/address/0x5a0Aae59D09fccBdDb6C6CcEB07B7279367C3d2A)** managed jointly by the [Optimism Security Council](https://gov.optimism.io/t/intro-to-optimisms-security-council/6885) and the Optimism Foundation. -OP Stack chains **may also contain unknown bugs that could lead to the loss of some or all of the ETH or tokens held within the system**. +<Callout type="warning"> + The security of OP Stack chains is dependent on a [multisig](https://etherscan.io/address/0x5a0Aae59D09fccBdDb6C6CcEB07B7279367C3d2A) managed jointly by the [Optimism Security Council](https://gov.optimism.io/t/intro-to-optimisms-security-council/6885) and the Optimism Foundation. + + OP Stack chains may contain unknown bugs that could lead to the loss of some or all of the ETH or tokens held within the system. +</Callout>
72-72: Add context for archived link.The web.archive.org link should include a note about when it was archived for better context and transparency.
pages/chain/security/privileged-roles.mdx (3)
11-12: Improve conciseness in the introductionConsider rephrasing for better clarity and conciseness:
-In their current state, OP Stack chains still include some "privileged" roles that give certain addresses the ability to carry out specific actions. +OP Stack chains currently include privileged roles that grant specific capabilities to designated addresses.
41-41: Remove redundant phraseThe phrase "on OP Stack chains" is redundant in this context.
-No one has the private key for `0x6B1BAE59D09fCcbdDB6C6cceb07B7279367C4E3b` on OP Stack chains, which means the only way for the L2 ProxyAdmin owner to send transactions is via deposit transactions from the L1 `0x5a0Aae59D09fccBdDb6C6CcEB07B7279367C3d2A` address. +No one has the private key for `0x6B1BAE59D09fCcbdDB6C6cceb07B7279367C4E3b`, which means the only way for the L2 ProxyAdmin owner to send transactions is via deposit transactions from the L1 `0x5a0Aae59D09fccBdDb6C6CcEB07B7279367C3d2A` address.
191-191: Improve sentence structureThe current sentence structure is complex and could be simplified.
-The Mint Manager Owner is an address that controls the [`MintManager`](https://github.com/ethereum-optimism/optimism/blob/62c7f3b05a70027b30054d4c8974f44000606fb7/packages/contracts-bedrock/contracts/governance/MintManager.sol) contract that can be used to mint new OP tokens on OP Stack chains. +The Mint Manager Owner controls the [`MintManager`](https://github.com/ethereum-optimism/optimism/blob/62c7f3b05a70027b30054d4c8974f44000606fb7/packages/contracts-bedrock/contracts/governance/MintManager.sol) contract, which can mint new OP tokens on OP Stack chains.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
pages/chain/addresses.mdx(1 hunks)pages/chain/getting-started.mdx(4 hunks)pages/chain/networks.mdx(1 hunks)pages/chain/security/faq.mdx(2 hunks)pages/chain/security/privileged-roles.mdx(6 hunks)pages/chain/security/security-policy.mdx(2 hunks)pages/chain/testing/testing-apps.mdx(2 hunks)pages/chain/tokenlist.mdx(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- pages/chain/tokenlist.mdx
- pages/chain/networks.mdx
🧰 Additional context used
📓 Path-based instructions (6)
pages/chain/addresses.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/chain/security/security-policy.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/chain/testing/testing-apps.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/chain/security/faq.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/chain/getting-started.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/chain/security/privileged-roles.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
🪛 LanguageTool
pages/chain/security/security-policy.mdx
[style] ~31-~31: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...fi.com/bounty/optimism/). The impact of any and all reported issues will be considered and ...
(EN_WORDINESS_PREMIUM_ANY_AND_ALL)
[uncategorized] ~31-~31: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...d all reported issues will be considered and the program has previously rewarded sec...
(COMMA_COMPOUND_SENTENCE_2)
pages/chain/security/faq.mdx
[grammar] ~10-~10: Possible agreement error. The noun OP seems to be uncountable; consider using: “much OP”, “a good deal of OP”.
Context: ...components' # OP Stack security model Many OP Stack chains, such as OP Mainnet, are a...
(MANY_NN_U)
[style] ~17-~17: For conciseness, consider replacing this expression with an adverb.
Context: ...trong as its lowest common denominator. At the moment, **it's important to understand that th...
(AT_THE_MOMENT)
[style] ~36-~36: This phrase is redundant. Consider using “inside”.
Context: ...ws the withdrawal was actually included inside of the OP Stack chain. Withdrawals are pro...
(OUTSIDE_OF)
pages/chain/getting-started.mdx
[uncategorized] ~55-~55: A comma might be missing here.
Context: ...ou debug parts that are OP Stack chains specific such as calls to bridges to transfer ET...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (4)
pages/chain/getting-started.mdx (1)
12-12: Consider archiving external links.The Medium article link is already using web.archive.org, which is good practice. However, consider adding a note about the archive date for context.
pages/chain/security/privileged-roles.mdx (3)
17-17: LGTM!The description is clear and maintains proper terminology.
89-90: LGTM!The description accurately explains the Batcher's role and maintains consistent terminology.
165-171: LGTM!The Guardian's description and capabilities are clearly explained with consistent terminology.
Still needs various fixes and nav work.
Closes https://github.com/ethereum-optimism/devrel/issues/371
Ensure we add redirects